Configuration Variables
A list of FMOS configuration settings that are customizable by local administrators.
Variables listed as critical must be present in the system configuration file when used during initial deployment (i.e. for automatic configuration). Variables listed as required must be present if the server holds one or more of the roles listed in the applies to field.
Using the command fmos -help will provide a complete list of available commands.
Additional configuration variables are included at the end of relevant chapters.
Operating System Configuration
| Command | Type | Required | Default | Function |
|---|---|---|---|---|
| all_proxy | Strong | No | The proxy URL for use by all protocols (including HTTP, HTTPS, FTP, raw TCP, etc.) | |
| auto_backup | Mapping | No | Defines how and when to run backups automatically. | |
| auto_backup.args | String | No | - -quiet - -prune | Arguments to pass to fmos backup. See fmos backup --help for possible options. If this option is null or empty, no arguments will be passed. |
| auto_backup.date | Number | No | 1 | When auto_backup.schedule is monthly, this defines the day of the month on which the backup will be performed. |
| auto_backup.enabled | Boolean | No | Whether or not to enable automated backups. This defaults to true if the server holds the database role, and false otherwise. | |
| auto_backup.hour | Number | No | 23 | Defines the hour when the backup will be performed (does not apply when auto_backup.schedule is hourly). |
| auto_backup.minute | Number | No | 48 | Defines the minute of the hour when the backup will be performed. |
| auto_backup.schedule | String | No | daily | Defines how often automatic backups should be performed. Choices: daily, hourly, monthly, weekly. |
| auto_backup.weekday | Number | No | 0 | When auto_backup.schedule is weekly, this defines the day of the week on which the backup will be performed. The number must be between 0 and 7, where 0 and 7 are both Sunday, 1 is Monday, etc. |
| fm_roles | Mapping | No | The FireMon roles the server will hold. | |
| fm_roles.as | Boolean | No | Application Server. | |
| fm_roles.db | Boolean | No | Database. | |
| fm_roles.dc | Boolean | No | Data Collector. | |
| fm_roles.nd | Boolean | No | Normalization Worker. | |
| fqdn | String | Yes-critical | The fully-qualified domain name of the server. | |
| http_proxy | String | No | The proxy URL to use for HTTP connections. | |
| https_proxy | String | No | The proxy URL to use for HTTPS connections. | |
| notify_recipients | String | No | Whitespace-separated list of email addresses to whom system notifications should be sent. | |
| network | Mapping | Yes-critical | This section introduces the configuration for system network connections. | |
| network.dns1 | String | No | The IP address of the first DNS server. | |
| network.dns2 | String | No | The IP address of the second DNS server. | |
| network.dns3 | String | No | The IP address of the second DNS server. | |
| network.gateway | String | No | The IP address of the default gateway on the local network. | |
| network.interfaces | Mapping | Yes-critical | Network interface configuration. | |
| network.interfaces[ ].addr | String | No | The IPv4 address for the interface (required when mode is manual). | |
| network.interfaces[ ].dhcp6v | Mapping | No | DHCPv6 options. | |
| network.interfaces[ ].addr6 | String | No | The IPv6 address and prefix length for the interface (only valid when mode is manual). | |
| network.interfaces[ ].dhcpv6.enabled | Boolean | No | True | Whether or not to enable DHCPv6 for the interface. |
| network.interfaces[ ].dhcpv6.pd | Boolean | No | False | Request a prefix be delegated to this host. |
| network.interfaces[ ].dhcpv6.stateless | Boolean | No | False | Use DHCPv6 in stateless mode. |
| network.interfaces[ ].dhcpv6.temporary | Boolean | No | False | Request a temporary address. |
| network.interfaces[ ].enabled | Boolean | Yes | Whether or not the interface should be activated at boot. | |
| no_proxy | String | No | Comma-separated list of host names to which direct connections should be made (without using the proxy set for the specific protocol) | |
| ntp | Mapping | No | Settings for network time. | |
| ntp.keys | List of Mappings | No | NTP authentication keys. | |
| ntp.keys[ ].id | Number | Yes | The numeric ID of the key (must be greater than 0). | |
| ntp.keys[ ].key | String | Yes | The key password. | |
| ntp.keys[ ].type | String | No | The type of key. Available: MDS / RMD128/ RMD160 / RMD256 / RMD320 / SHA1 / SHA256 / SHA384 / SHA512 / TIGER / WHIRLPOOL | |
| ntp.mode | String | Yes | Choices: dhcp / manual / none | |
| ntp.servers | List of Mappings | No | NTP servers (required when mode is manual). | |
| ntp.servers[ ].host | String | No | Host name or IP address of the server. | |
| ntp.servers[ ].key_id | Number | No | The ID of the key (from ntp.keys) used for authentication with this server. | |
| remote_syslog | List of Mappings | No | Settings for remote syslog servers. | |
| remote_syslog[].host | String | Yes | FQDN for the remote logging host. | |
| remote_syslog[].mode | String | No | UDP |
Communication protocol to use to connect to the host. Choices: TCP / UDP |
| remote_syslog[].port | Number | No | Port to use to connect to the remote logging host. | |
| remote_syslog[].usetls | Boolean | No | False | Use TLS with TCP. |
| send_perf_data | Boolean | No | False | Whether or not to send performance metrics to FireMon for diagnostic purposes. |